Improve component prop documentation #4699
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Makes it obvious that passing a function to the
component
prop does not treat it like a render prop, and it is in fact a component.Previously not explicitly referring to this as a component and using camel case naming implied that this prop was treated as a render prop, and not rendered with
React.createElement
as stated just above.I have used the same naming as the class component example, and appended "component" to references of "stateless function".
This has the added benefit that, when necessary, these components can be used without
redux-form
due to the capitalized first character e.g.I've also changed "normal component" back to "class component" as both styles are equally "normal".